/*
 * Copyright (C) 2018 xuexiangjys(xuexiangjys@163.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.xuexiang.xdlink.component.protocol;

import com.xuexiang.xdlink.component.IRecycle;
import com.xuexiang.xdlink.component.command.IProtocolCommand;
import com.xuexiang.xdlink.component.message.IDataInfo;
import com.xuexiang.xdlink.component.message.IRequestMessage;
import com.xuexiang.xdlink.component.message.IResponseMessage;
import com.xuexiang.xdlink.exception.ConnectException;
import com.xuexiang.xdlink.exception.ProtocolException;

import java.util.List;

/**
 * 协议的实现接口，主要负责消息协议的处理
 *
 * @author xuexiang
 * @since 2018/8/13 下午11:29
 */
public interface IProtocol extends IRecycle {

    /**
     * 处理消息，获得有用的信息数据【IResponseMessage -> IDataInfo -> 上抛】
     *
     * @param messages 解析成功的消息列表
     * @throws ProtocolException
     */
    void handleMessage(List<IResponseMessage> messages) throws ProtocolException;

    /**
     * 向通道发送协议命令【IProtocolCommand -> IMessage -> 下抛】
     *
     * @param command
     * @throws ConnectException
     */
    void executeCommand(IProtocolCommand command) throws ProtocolException;

    /**
     * 设置协议的监听接口
     *
     * @param listener
     */
    void setOnProtocolListener(OnProtocolListener listener);

    //================================消息、数据接收===============================//

    /**
     * 协议收到消息解析器解析出来的消息的监听【消息解析器产生的消息】
     *
     * @param responseMessage 响应协议消息
     */
    void onReceivedMessage(IResponseMessage responseMessage) throws ProtocolException;

    /**
     * 协议解析消息产生数据信息的监听【协议产生的事件】
     *
     * @param dataInfo 数据信息
     */
    void onReceivedDataInfo(IDataInfo dataInfo) throws ProtocolException;

    //================================消息、数据回复===============================//
    /**
     * 向设备回复消息
     *
     * @param requestMessage 请求协议消息体
     */
    void onReplyMessage(IRequestMessage requestMessage) throws ProtocolException;

}
